TCheckPointReturnCode

SoftwareShield CheckPoint™ License Server > CheckPoint™ License Server Interfaces > CheckPoint_Webservice_References > TCheckPointReturnCode

## TCheckPointReturnCode

The TCheckPointReturnCode enumeration is used in several CheckPoint function calls. The values indicate the outcome of an operation.

enum TCheckPointReturnCode
{

cprcInvalidSN =0,
cprcNoActivationsRemaining =1,
cprcCodeGenerated =2,
cprcFormatOK =3,
cprcDeactivated =4,
cprcMissingMainLF =5,
cprcMainLFCorrupt =6,
cprcBadLPJFileName =7,
cprcDeactivationIDOnly =8,
cprcCodeInvalidBadId =9,
cprcCodeBadFormat =10,
cprcParamOutOfRange =11,
cprcFPOutOfRange =12,
cprcWongParamType =13,
cprcShelfLifeOutOfRange =14,
cprcInvalidAuthID =15,
cprcInvalidSessionID =16,
cprcCheckedIn =17,
cprcINTERNAL_FAILURE =18,
cprcCONNECTION_FAILURE =19

};

The meaning of a particular TCheckPointReturnCode depends on the context from which it was returned.

The following descriptions of meaning is meant as a guide:

#### TCheckPointReturnCode Meaning:

cprcInvalidSN: This return code indicates that the serial number that was entered is invalid

cprcNoActivationsRemaining: This return code indicates that the CheckPoint License Server was invoked to perform a Serial Number Code exchange, however, the Serial Number that was passed had no remaining un-consumed Activations.

cprcCodeGenerated: A successful code generation would return this code

cprcFormatOK: If a Format Check was performed in a function, this code will be returned if the format is valid.

cprcDeactivated: This return code indicates the license has been deactivated. The only way to reactivate the license is using a Reactivate License Authorization Definitions.

cprcMissingMainLF; This return code indicates that the main license file was not found in the directory you specified in the parameter in the call to StartUp. Further - if your OnMissingLicenseFile event was connected, either the user failed to find it, they selected an incorrect file, the file was unable to be moved, read or written or your event handler simply failed to assign the actual file name path parameter correctly. Be sure the Main License File name you pass to the StartUp function is correct and that the file is located correctly as described in the documentation for StartUp

cprcMainLFCorrupt: This return code indicates that the Main License File was found in the correct location, however the ClientProtector was either unable to open it, read it, the contents had been tampered with or you simply provided the wrong Main License File Password parameter in the call to StartUp (which would result in the decryption process failing). In almost every case, when this occurs it is impossible to recover the license (almost certainly caused by tampering). The user may need a new license file from you.

cprcBadLPJFileName: This indicates that the wrong LPJ is being referenced.

cprcDeactivationIDOnly: This return code indicates that a call failed because the request corresponded to a Deactivation Authorization Definition. Deactivation Authorization Definitions can only be manipulated by a call to RequestDeactivation.

cprcCodeInvalidBadId: This return code indicates that a function call which either verifies Activation Codes or manipulates Authorization Definitions directly, failed because either the embedded Authorization Definition ID (in the case of an Activation Code) or the specified Authorization Definition ID (in the case of other function calls) specified a value which was not valid for the license.

cprcCodeBadFormat: This return code indicates that a function call which either directly or indirectly verifies Activation Codes failed because the general format of the input Activation Code was incorrect. (Size wrong, dashes missing or in the correct place, invalid characters etc.)

cprcParamOutOfRange: This return code indicates that a parameter used in a call was out of valid range

cprcFPOutOfRange: This indicates that the Fingerprint used in a call is outside the range of acceptable fingerprints.

cprcWongParamType: This indicates the wrong parameter type was passed.

cprcShelfLifeOutOfRange: This indicates that the Shelf Life of a Authorization id is not within an acceptable range.

cprcInvalidAuthID: This return code indicates that the Authorization ID that is being referenced is not valid.

cprcInvalidSessionID: This return code indicates that the End user's session ID is invalid.

cprcCheckedIn: This indicates that a Check-in call was successful

cprcINTERNAL_FAILURE: This return code indicates that a failure occurred inside the CheckPoint component. You should never receive this return code. If you do, this indicates a bug in the CheckPoint component. Also, please report the bug and exactly how to replicate it to SoftwareShield.

cprcCONNECTION_FAILURE: This return code indicates that some operation that required or directed communication with the CheckPoint License Server could not continue because the CheckPoint Server could not be contacted

#

#